home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 1.iso / ARGONET / PD / SOUND / TIMPLAYER.ZIP / !DigitalCD / !Help < prev    next >
Text File  |  1998-03-23  |  16KB  |  303 lines

  1. !Help for DigitalCD v2.28
  2. © André Timmermans 1996-1998
  3.  
  4. Legal stuff
  5. ===========
  6.  
  7. This program is 'FreeWare' and must not be copied to make a profit. This means that individuals, Public Domain libraries and Disc magazines may distribute DigitalCD as long as they charge no more than required by the distribution costs (disc, postage, ...).
  8.  
  9. You may not distribute modified versions of this program and the program must be distributed as a whole. You are not allowed to use bits of it in your own programs.
  10.  
  11. This program is supplied as is, and no liability can be accepted for damage or loss resulting from the use or misuse of the software.
  12.  
  13. Introduction
  14. ============
  15.  
  16. DigitalCD is a desktop music player compatible with RISC OS 3.1 or later (including StrongArm). It provides independent control panels for any connected CD drive and music files playlists.
  17.  
  18. To a music file, open the 'Music Files' control panel from the icon bar menu or click SELECT on the icon bar, then drop the file to play on it. Music files currently supported are: Digital Symphonies (&10B), Protrackers (&CB6), Matrix (&00B), ScreamTrackers (&C02), FastTrackers (&C03)
  19. and a few ImpulseTrackers (&C04).
  20.  
  21. To create a playlist, select 'Playlists' from the icon bar menu. From the Playlists window menu select 'New', an empty playlist will appear. Finally, drop the files to play on it, or even better, drop a directory on it, all the supported music files in it and subdirectories will be added to the playlist.
  22. To play files from the playlist, set the 'Music Files' control panel in Program mode and start playing.
  23.  
  24. To play a CD, open the corresponding control panel from the icon bar menu or in the case of CD drive 0 click ADJUST on the icon bar.
  25.  
  26. DigitalCD supports interactive help. To make use of this feature, load the Help application supplied with your computer, or an alternative Help provider such as Bubble Help. Making use of this feature (which works on menus as well) should help you to work out what everything does if you can't guess.
  27.  
  28. I have tried to render the program as straightforward as possible in use and I have put as much information as possible in the interactive help, so use it! Should you encounter troubles, then read the rest of this help file.
  29.  
  30. The Control Panels
  31. ==================
  32.  
  33. Here follows a description of a control panel from top to bottom and
  34. from left to right.
  35.  
  36. 1) The Title Bar contains two lines of text. The first one will display, when relevant, the author and title of the track list. The second one displays the title of the current track.
  37.  
  38. 2) The Track Counter shows the track that is currently played. Clicking on the counter will open a list from which a new track can be chosen.
  39.  
  40. 3) The Timer has four available modes: elapsed time, remaining time, total elapsed time and total remaining time. The first two modes refer to timings within the current track, while the second two refer to timings for the whole list of tracks. Clicking SELECT or ADJUST on the timer will allow you to cycle within the four modes.
  41.  
  42. When are playing music files the timer will only display a pseudo time based on the current pattern and event. I did it because it was easier for me to use the same code for CDs and music files, but in the end it's a good thing. First, important changes in the music often occur on the start of a new pattern, so with a pattern display you start expect these changes. Next, according to playing speed changes and other subtle effects, you will experience that time is relative and that sometimes you can even travel back in time. ;-)
  43.  
  44. 4) The Position Bar is a graphical representation of the current position within the track. You can click on the bar to move to a given position within the track.
  45.  
  46. 5) The Volume Slider will allow you to alter the loudness of the played tracks by dragging it up or down.
  47.  
  48. Important Note:
  49. When playing music files you can also edit the properties of the track and specify a volume in percents of this main volume. I can only recommend you set the main volume to an adequate value, then for each track in the playlist only alter the relative volume. This will ensure that once the playlist is saved you will not need anymore to fiddle with the volume slider on each track change.
  50.  
  51. 6) The Mode Switches alters the way tracks are played. By clicking with SELECT or ADJUST, you can cycle within the possible values of each of the following switches:
  52.  
  53. + Repeat has four modes:
  54.  
  55.   - play track list,
  56.   - loop on track list,
  57.   - loop on current track and
  58.   - play a single track (useful when you think:
  59.     Ok, It's nearly time to leave,
  60.     I will stop when this one is played).
  61.  
  62. + Intro scan:
  63. when set, will only play the start of the tracks, allowing you to search a given track. The time spend on each track can be altered from within the choices window.
  64.  
  65. + Shuffle:
  66. when set, will play the tracks in random order.
  67.  
  68. + Program:
  69. when set, will play the tracks which belongs to the preference list of the current CD or the tracks from a music files playlist.
  70.  
  71. 7) The Custom Area
  72.  
  73. The content his section depends on the type of player.
  74.  
  75. For a CD player there is a single icon that opens the CD Database window.
  76.  
  77. For the Music file player four icons are shown to:
  78.  
  79. + remove the current track from the playlist,
  80. + delete (after confirmation) the music file corresponding to the current track,
  81. + edit the properties of the current track or
  82. + open the current playlist.
  83.  
  84. 8) The Main Buttons
  85.  
  86. + Play allows you to:
  87.   - start playback,
  88.   - restart the current track or
  89.   - resume playback on a paused track.
  90.  
  91. + Pause allows you to:
  92.   - pause playback or
  93.   - resume playback on a paused track.
  94.  
  95. + Stop allows you to stop playback.
  96.  
  97. 9) The Move Buttons
  98.  
  99. + Rewind allows you to move back within the current track,
  100. + Forward allows you to move forward within the current track,
  101. + Previous allows you to move to the previous track and
  102. + Next allows you to move to the next track.
  103.  
  104. The Music Files Playlist windows
  105. ================================
  106.  
  107. On top of the window you will find from left to right the usual content of a save box: icon for dragging, filename entry box and save button. 
  108.  
  109. Below the icons you will find a list of music files, this is where you will have to drop the files or directories you want to play. The list can be managed either by the mouse or by the keyboard.
  110.  
  111. Mouse operations:
  112. -----------------
  113.  
  114. Click with ADJUST on the window if the window does not have the focus,
  115. will set the focus to the last item which owned the focus.
  116.  
  117. Click/drag with SELECT on an unselected item will clear any previous selection and start the selection of a range of items.
  118.  
  119. Click/drag with ADJUST will preserve the current selection and invert the selection status of a range of items.
  120.  
  121. Click/drag with SELECT on a selected item will start dragging the current selection. You will be able to drag the selection to a filer, another application, the 'Playlists' window where it will create a new playlist,
  122. this playlist where a ghost caret will show you the destination of your
  123. move (copy if shift is pressed), or another playlist where a ghost caret will show you the destination of your copy (move if shift is pressed).
  124.  
  125. Click with ADJUST on a list which as not the focus sets the focus to that list
  126. without altering the current selection.
  127.  
  128. Several additional commands are provided by clicking MENU on the list:
  129.  
  130. + Validate will remove from the list any file which have an invalid path. This is useful for removing deleted files from the list.
  131.  
  132. + Properties will allow you to edit the properties of the currently selected item.
  133.  
  134. + Delete Files will allow you to remove the currently selected items from the playlist and delete (after confirmation) the corresponding files.
  135.  
  136. + Standard Cut, Copy and Paste commands (Global Clipboard is supported).
  137.  
  138. + Select All and Clear commands.
  139.  
  140. Keyboard operations:
  141. --------------------
  142.  
  143. Usual actions on [shift][ctrl] arrow, page up, page down
  144.  
  145. - Ctrl + A selects all items
  146. - Ctrl + Z clears all items
  147. - Ctrl + C copy the selection to the clipboard
  148. - Ctrl + V inserts the clipboard content before item which has the focus
  149. - Ctrl + X copy the selection to the clipboard, then deletes the selection
  150. - Del deletes the selection (no use of the clipboard)
  151.  
  152. - Ins toggles follow mode on/off (use the arrows and you will understand).
  153. - Shift + Ins starts/ends a selection of an area.
  154. - Ctrl + Ins starts/ends an inversion of an area.
  155.  
  156. Playlist File Format:
  157. ---------------------
  158.  
  159. The file format is purely textual and can be edited by hand if required (e.g. you moved your files to another drive or directory).
  160.  
  161. To keep file sizes as small as possible a mechanism of current path is used and the following algorithm is used to read the file:
  162.  
  163. cur_path = ""
  164. while more lines to read
  165.   read line
  166.   if line is dot terminated (line is a path)
  167.     cur_path = line
  168.   else (line is in format <file> or <file>*<options>)
  169.     filename = cur_path + file
  170.     if (options section)
  171.       fileoptions = options
  172.     else
  173.       fileoptions = default options
  174.     endif
  175.   endif
  176. endwhile
  177.  
  178. options has the following format:
  179. <name>=<value>,...,<name>=<value>
  180.  
  181. but currently the only one defined is:
  182. v=relative volume in %
  183.  
  184. File example:
  185. ADFS::HardDisc4.$.MultiMedia.Sound.Symphony.Songs.A.
  186. Anette*v=250
  187. ANewJack
  188.  
  189. The Playlists window
  190. ====================
  191.  
  192. This window allows you to manage playlists: from this window you can create a new playlist, remove existing playlists (closing the playlist window does not remove the document from memory, it only hides it from view) and finally choose the playlist from which the 'Music Files' control panel will extract the files to play.
  193.  
  194. The CD Database
  195. ===============
  196.  
  197. DigitalCD stores the identifier (the one returned by WhichDisc) of each CD it plays. From this window you can browse through the identifiers and assign the name of an author and a title to the CD and to each track of the CD. A Preference List window can also be opened to define an alternative sequence for playing the tracks of the CD.
  198.  
  199. The Preference List
  200. ===================
  201.  
  202. The preference list window is used to define an alternative sequence for playing the tracks of a CD. This sequence will be used when the CD control panel is in Program mode.
  203.  
  204. The window contains two list: on the left the preference list and on the right the list of tracks available on the CD.
  205.  
  206. From the right list you can select tracks and drop them at the desired position in the preference list.
  207.  
  208. From the preference list you can move/copy/delete tracks, clear the list or initialise it to reflect the list of available tracks. The tracks in this list can be mixed in any order and any track may inserted several times in the list.
  209.  
  210. Your changes will only be taken into account when the Save button is pressed in the CD Database window.
  211.  
  212. Choices
  213. =======
  214.  
  215. 1) Startup options
  216.  
  217. Restore open windows will ensure that DigitalCD stores the position of open  windows before quitting the application so that when the application is restarted these windows will be reopened at the position where you leaved them.
  218.  
  219. Load playlist allows DigitalCD to load a default playlist at startup (unless the application is started by double clicking on a playlist). To specify the filename of the default playlist, type its name in the entry box or drop its icon onto it.
  220.  
  221. 2) Players
  222.  
  223. + Use filename as track title will prevent DigitalCD from using the title of the music files in the playlists and in the player title bar. Instead the leafname of the file will be used.
  224.  
  225. + CDFS version with 150 frames bug
  226.  
  227. On some versions of CDFS (or CDFSSoftAtapi?) there is a bug in the code which is responsible for a 150 frames (2 seconds) difference between the value you specify to the CD interface to move to a given position on the disc and the value returned when asking the current position on the CD.
  228.  
  229. Is the problem present on your machine? Well, start playing a CD and use the Rewind and Forward buttons they should normally move you 1 second backward or forward in the track. If you experience something as the Forward button moving you backward in the track, turn the switch on.
  230.  
  231. + The Sample rate is the time interval at which the players feeds the sound hardware with sound sample information. The smaller the interval is, the higher the output frequency will be. 24µs will give 41600Hz (CD quality), which is the value I used even on my old A310, and which I recommend. Should you experience problems then turn it down to 48µs (20000Hz).
  232.  
  233. + Intro scan length is the number of seconds players configured in Intro Scan mode will play a track before moving to the next track. The default is 15 secs.
  234.  
  235. Accepted FileTypes
  236. ==================
  237.  
  238. Inside the !DigitalCD directory you will find a file called Setup and in this file a section [FileTypes]. On startup the application scans this section for lines in the form:
  239.  
  240. filetype = loader1, loader2, ...
  241.  
  242. where filetype is a RISCOS filetype, loader1 the first player that will attempt to play the file, loader2 the second one if the first refuses, etc.
  243.  
  244. For example CB6 = tim, qtm tells DigitalCD to accept filetype CB6 and play such files with the TimPlayer module, or with QTM if TimPlayer refuses.
  245.  
  246. For a complete list of loaders, see just below in the Credits.
  247.  
  248. Credits
  249. =======
  250.  
  251. Thanks to the authors of the following modules:
  252.  
  253. ds  DSymphonyPlayer 1.46 © BASS 1991-1997, Freeware
  254. qtm QTMTracker      1.27 © Phoenix/QUANTUM
  255. trk matrixTRK       0.89 © Marko Lukat & Michael Pohle
  256. xpr XprMod          0.51 © Skoe of Expression
  257. tim TimPlayer       0.00 © Timmermans André
  258.  
  259. Contact
  260. =======
  261.  
  262. If you want to contact me, my e-mail address is:
  263.  
  264. tim@swn.sni.be
  265.  
  266. and this is my snail-mail address:
  267. Timmermans André
  268. Rue du Vert Coron, 17
  269. 7600 Péruwelz
  270. Belgium
  271.  
  272. History
  273. =======
  274.  
  275. 2.00 01 Dec 96 First release ready version (but never released).
  276. 2.01 06 Jan 97 Correction of play button behaviour when track is playing or paused.
  277. 2.02 18 Jan 97 Correction, F12 in list does not work
  278. 2.03 09 Feb 97 Faster memory deallocation through wimp slot shrinking on Wimp_Poll only
  279. 2.04 21 Feb 97 Rewrite of selection dragging in Lists
  280. 2.05 04 Apr 97 Rewrite of CD driver to minimise CD SWI calls (due to "Tool - Undertow")
  281. 2.06 19 Apr 97 Introduced support for QTM player, storage of Volume info
  282. 2.07 20 Apr 97 Alpha support of multiple playlists
  283. 2.08 21 Apr 97 Choices: Update button status after dragging of a play list
  284. 2.09 03 May 97 Rewrote saving methods and handling of dragging
  285. 2.10 17 May 97 Added menu on playlists; volume could not be dragged to 100%
  286. 2.11 25 May 97 Completed support for multiple playlists
  287. 2.12 28 May 97 Now perform dragging in CD Preference List as for other lists
  288. 2.13 23 Jun 97 Introduced new icons in player, redesigned other ones
  289. 2.14 24 Jun 97 Support for removal of current track from playlist
  290. 2.15 25 Jun 97 Support for deletion of file corresponding to current track
  291. 2.16 05 Jul 97 Alpha support for track volume in % in main volume
  292. 2.17 14 Jul 97 Edition of track volume in % added
  293. 2.18 20 Jul 97 Corrected edition of track volume
  294. 2.19 27 Jul 97 Corrected long standing random crash on exit
  295. 2.20 03 Aug 97 Redesigned playlist windows, much smaller now.
  296. 2.21 10 Aug 97 Changed a few details, messages and wrote 80% of the help file.
  297. 2.22 19 Sep 97 Removed usage of RiscOSLib, got official filetype allocation
  298. 2.23 03 Oct 97 Inserted timer to check less often CD position
  299. 2.24 04 Oct 97 Extended Playlists limits from 999 to 9999 files
  300. 2.25 29 Oct 97 Included XprMod to support S3M (&C02) and XM (&C03) songs
  301. 2.26 15 Nov 97 Menu seperators used a gray background
  302. 2.27 14 Jan 98 Included TimPlayer module and added Setup file to define the list of accepted filetypes.
  303. 2.28 02 Feb 98 Fixed bug in position bar when adding/removing files from the list